CellRendererPixbuf: Improve property docs
authorDaniel Boles <dboles@src.gnome.org>
Wed, 22 Nov 2017 18:57:48 +0000 (18:57 +0000)
committerDaniel Boles <dboles@src.gnome.org>
Wed, 22 Nov 2017 20:48:02 +0000 (20:48 +0000)
Add Since annotations for the stock-* properties.
Add a doc comment for :stock-size in order to link to GtkIconSize.
Document :stock-detail as deprecated. It does nothing & is gone in GTK+4

gtk/gtkcellrendererpixbuf.c

index 30dcc1b871e614a2c479c4e51fc1bd443174edc9..85eab79d6971514fa75ddab4ed1ddce66f7beb27 100644 (file)
@@ -185,6 +185,8 @@ gtk_cell_renderer_pixbuf_class_init (GtkCellRendererPixbufClass *class)
   /**
    * GtkCellRendererPixbuf:stock-id:
    *
+   * Since: 2.2
+   *
    * Deprecated: 3.10: Use #GtkCellRendererPixbuf:icon-name instead.
    */
   g_object_class_install_property (object_class,
@@ -195,6 +197,13 @@ gtk_cell_renderer_pixbuf_class_init (GtkCellRendererPixbufClass *class)
                                                        NULL,
                                                        GTK_PARAM_READWRITE | G_PARAM_DEPRECATED));
 
+  /**
+   * GtkCellRendererPixbuf:stock-size:
+   *
+   * The #GtkIconSize value that specifies the size of the rendered icon.
+   *
+   * Since: 2.2
+   */
   g_object_class_install_property (object_class,
                                   PROP_STOCK_SIZE,
                                   g_param_spec_uint ("stock-size",
@@ -205,6 +214,13 @@ gtk_cell_renderer_pixbuf_class_init (GtkCellRendererPixbufClass *class)
                                                      GTK_ICON_SIZE_MENU,
                                                      GTK_PARAM_READWRITE));
 
+  /*
+   * GtkCellRendererPixbuf:stock-detail:
+   *
+   * Since: 2.2
+   *
+   * Deprecated: 3.22: This property does nothing. Use CSS to theme widgets.
+   */
   g_object_class_install_property (object_class,
                                   PROP_STOCK_DETAIL,
                                   g_param_spec_string ("stock-detail",